Repository navigation
docs(ocr): fix Python snippets for client.post - #169
Merged
Merged
Conversation
- Pass fields as keyword arguments instead of body={...}, which the SDK
wraps again and sends as {"body": {...}}
- Use response.pages; GenericResponse is not subscriptable
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the OCR Python example corrections.
No open issues 🎉
What changed in this PR
Corrects the Default and Self-Hosted Python examples for /ocr to match the client’s request and response handling.
Changes:
- Passes request fields directly as keyword arguments instead of nesting them under
body. - Uses
response.pagesto access pages on the response object.
| File | Description |
|---|---|
openapi.yaml |
Fixes request construction and response access in both OCR Python examples. |
Review effort: Balanced
kiran-4444
approved these changes
Nov 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes both Python tabs (Default and Self-Hosted) under
/ocr.client.post(url, **kwargs)sends every kwarg exceptfiles,headersandstreamas the JSON body, sobody={...}was sent as{"body": {...}}. Fields are now passed as keyword arguments.GenericResponseand is not subscriptable, soresponse["pages"]raisedTypeError. Now usesresponse.pages.The
/rerankPython samples already use keyword arguments. Companion docs-core fix is on branchfix/ocr-python-snippetsin Portkey-AI/docs-core.